Update brew in README.md #95

hbmartin · 2024-08-21T23:47:46Z

Summary by Sourcery

Update the README.md to include a new badge for the Homebrew version and revise the Homebrew installation instructions.

Documentation:

Update the Homebrew installation instructions in the README.md to reflect the new installation command.

Summary by CodeRabbit

New Features
- Introduced a new badge displaying the Homebrew version of the package for improved visibility.
Documentation
- Simplified the Homebrew installation command for easier user access and understanding.
- Enhanced clarity of the README to improve user engagement and experience.

coderabbitai · 2024-08-21T23:47:52Z

Walkthrough

The updates to the README.md file for the graphviz2drawio project enhance user experience by adding a new badge indicating Homebrew availability and simplifying the installation command. These changes aim to improve clarity and accessibility for users who utilize Homebrew as their package manager, making it easier and quicker to install the package.

Changes

Files	Change Summary
`README.md`	Added a Homebrew version badge; simplified the Homebrew installation command from `brew install hbmartin/...` to `brew install graphviz2drawio`.

Poem

🐰 In the garden where code flowers grow,
A badge shines bright, a new way to know.
With a command so simple, oh what a delight,
Installing with ease makes everything right!
Hops of joy for changes so grand,
In the world of graphviz, we take a stand! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sourcery-ai · 2024-08-21T23:47:57Z

Reviewer's Guide by Sourcery

This pull request updates the README.md file with changes to the badges displayed and the Homebrew installation command. The changes include adding a Homebrew version badge, removing the Black code style badge, and simplifying the Homebrew installation command.

File-Level Changes

Files	Changes
`README.md`	Added a Homebrew version badge to display the current version available through Homebrew
`README.md`	Removed the Black code style badge
`README.md`	Updated the Homebrew installation command to use a simpler, more direct format

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sonarcloud · 2024-08-21T23:48:07Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sourcery-ai

Hey @hbmartin - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-21T23:48:40Z

README.md

 [![Lint and Test](https://github.com/hbmartin/graphviz2drawio/actions/workflows/lint.yml/badge.svg)](https://github.com/hbmartin/graphviz2drawio/actions/workflows/lint.yml)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![Code style: black](https://img.shields.io/badge/🐧-black-000000.svg)](https://github.com/psf/black)


question (documentation): Removal of Black code style badge - can you explain the reasoning?

The Black code style badge has been removed. Is this intentional? If so, has there been a change in the project's coding standards or formatting tools?

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between d72aa3c and 83b4695.

Files selected for processing (1)

README.md (2 hunks)

Additional comments not posted (2)

README.md (2)

5-5: Great addition of the Homebrew badge.

This badge enhances visibility and accessibility for users who prefer Homebrew as their package manager.

20-20: Simplified Homebrew installation command is a welcome change.

This change aligns with standard practices and makes it easier for users to install the package.

Update brew in README.md

83b4695

sourcery-ai bot reviewed Aug 21, 2024

View reviewed changes

coderabbitai bot reviewed Aug 21, 2024

View reviewed changes

hbmartin merged commit ac74972 into master Aug 21, 2024
9 checks passed

hbmartin deleted the hbmartin-patch-1 branch August 21, 2024 23:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update brew in README.md #95

Update brew in README.md #95

hbmartin commented Aug 21, 2024 •

edited by sourcery-ai bot

Loading

coderabbitai bot commented Aug 21, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

sourcery-ai bot commented Aug 21, 2024 •

edited

Loading

sonarcloud bot commented Aug 21, 2024

sourcery-ai bot left a comment

sourcery-ai bot Aug 21, 2024

coderabbitai bot left a comment

Update brew in README.md #95

Update brew in README.md #95

Conversation

hbmartin commented Aug 21, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

Summary by CodeRabbit

coderabbitai bot commented Aug 21, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

sourcery-ai bot commented Aug 21, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sonarcloud bot commented Aug 21, 2024

Quality Gate passed

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Aug 21, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

hbmartin commented Aug 21, 2024 •

edited by sourcery-ai bot

Loading

coderabbitai bot commented Aug 21, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

sourcery-ai bot commented Aug 21, 2024 •

edited

Loading